/*$$
 * Copyright (c) 1999, Trustees of the University of Chicago
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with 
 * or without modification, are permitted provided that the following 
 * conditions are met:
 *
 *	 Redistributions of source code must retain the above copyright notice,
 *	 this list of conditions and the following disclaimer.
 *
 *	 Redistributions in binary form must reproduce the above copyright notice,
 *	 this list of conditions and the following disclaimer in the documentation
 *	 and/or other materials provided with the distribution.
 *
 * Neither the name of the University of Chicago nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE TRUSTEES OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *$$*/
package uchicago.src.sim.network;

import java.util.List;

public class AdjacencyMatrixFactory {

  private AdjacencyMatrixFactory() {}

  /**
   * Returns an AdjacencyMatrix of the appropriate type.
   *
   * @param rows the number of rows in the matrix
   * @param cols the number of cols in the matrix
   * @param type the type of the matrix. type refers to the size of the matrix
   * elements (ij values) and can be one of NetworkConstants.BINARY,
   * NetworkConstants.LARGE, NetworkConstants.SMALL
   */
  public static AdjacencyMatrix createAdjacencyMatrix(int rows, int cols,
    int type)
  {
    switch (type) {
      case NetworkConstants.BINARY:
        return new AdjacencyBitMatrix(rows, cols);

      case NetworkConstants.SMALL:
        return new AdjacencyByteMatrix(rows, cols);

      case NetworkConstants.LARGE:
        return new AdjacencyDoubleMatrix(rows, cols);

      default:
        throw new IllegalArgumentException("Illegal matrix type, must be one " +
            " of NetworkConstants.BINARY, NetworkConstants.LARGE, or " +
            "NetworkConstants.SMALL");
    }
  }

  public static AdjacencyMatrix createAdjacencyMatrix(List labels, int type) {
    switch (type) {
      case NetworkConstants.BINARY:
        return new AdjacencyBitMatrix(labels);

      case NetworkConstants.SMALL:
        return new AdjacencyByteMatrix(labels);

      case NetworkConstants.LARGE:
        return new AdjacencyDoubleMatrix(labels);

      default:
        throw new IllegalArgumentException("Illegal matrix type, must be one " +
            " of NetworkConstants.BINARY, NetworkConstants.LARGE, or " +
            "NetworkConstants.SMALL");
    }
  }
}